home *** CD-ROM | disk | FTP | other *** search
/ The 640 MEG Shareware Studio 2 / The 640 Meg Shareware Studio CD-ROM Volume II (Data Express)(1993).ISO / comm / backmail.zip / PMERGE.TXT < prev    next >
Text File  |  1990-01-14  |  8KB  |  147 lines
  1.     PMERGE:  Alethic BackMail phone directory merge utility
  2.  
  3. PMERGE allows one to merge all the data entries from a 'foreign' phone
  4. directory into one's own thus reducing a certain amount of drudge-work
  5. among a network of BackMailers.  To start PMERGE use the following syntax:
  6.  
  7.         PMERGE [-Bpathname -Q -Paaaxxxyyyy] <Enter>
  8.  
  9. Where the options are explained as follows:
  10.  
  11. -B is the path to the original phone directory.  The user may enter this
  12. switch explicitly or set an environment variable called BACKMAIL to this
  13. path (e.g. by entering the DOS command SET BACKMAIL=c:\mypath).
  14. IMORTANT NOTE:  when entering this path, DO NOT terminate with the
  15. 'backslash' character ("\"). If neither option is exercised then PMERGE
  16. will assume that the user's original phone directory is to be found in
  17. C:\BACKMAIL.
  18.  
  19. -Q requests 'quiet' mode.  When running in this mode PMERGE will not print
  20. error messages but rather will indicate fatal errors by means of exit
  21. codes alone.  These codes, the meaning of which is detailed below, may
  22. be retrieved by the DOS batch processor.
  23.  
  24. -P is the user's phone number which must be in ten digit format without
  25. spaces or punctuation symbols e.g. 8769024312.  As an alternative to
  26. entering this option on the PMERGE command line, the user can set an
  27. environment variable called PHONE to the required number.  If PMERGE can
  28. not discover the user's phone number either from the command line option
  29. or the environment, it aborts with an error message (or exit code alone
  30. depending on the mode).
  31.  
  32.  
  33.                             USAGE NOTES
  34.  
  35. PMERGE expects both the original and the 'foreign' phone directories to be
  36. named PHONE so evidently they cannot both be in the same subdirectory.  It
  37. is normally the case that one receives a new phone directory by means of
  38. BackMail, so it will be called PHONE and reside in the user's transfer
  39. subdirectory (where all files go that are received by BackMail).  PMERGE
  40. requires that the new phone directory be in the current subdirectory.  Here's
  41. a scenario:  a new phone directory is sent to the user and ends up in the
  42. subdirectory C:\BACKMAIL\TRANSFER.  The user can now either place the
  43. program PMERGE.EXE somewhere on their path (as set by the DOS command PATH=)
  44. or copy the program to the transfer subdirectory.  Now to merge the new
  45. phone directory with e user's original phone directory, the user issues the
  46. command:
  47.            CD C:\BACKMAIL\TRANSFER <Enter>
  48.  
  49. in order to make the transfer subdirectory current.  Next the user issues:
  50.  
  51.            PMERGE -P8174236543 <Enter>
  52.  
  53. where the string following the '-P' is the user's phone number including
  54. area code but without punctuation.  Notice that in this example, the user
  55. keeps the original phone directory in C:\BACKMAIL so there is no need to
  56. enter the -B option.  PMERGE will then print a 'banner' and a number of
  57. messages detailing its operation since 'quiet' mode is not in effect (the
  58. -Q option was not given).  When it has finished, the user's phone directory
  59. in C:\BACKMAIL will have been increased by the addition of those data numbers
  60. in the 'new' phone directory such that (1) the numbers in question did not
  61. already appear in the original directory (i.e. PMERGE will not create
  62. duplicate entries) and (2) The user's own number will not be included even
  63. if there is such an entry in the 'new' directory.  This is the reason that
  64. PMERGE insists on being told the user's telephone number before it will
  65. operate.
  66.  
  67.                 LIMITATIONS and CAUTIONS
  68.  
  69. PMERGE cannot 'merge in' new phone numbers if the user's current phone
  70. directory contains 3000 data entries or more already.
  71. If either the new directory or the original directory has become corrupted,
  72. then the result of running PMERGE will certainly inherit this corruption.
  73. Phone directories can become corrupt in a number of ways (not excluding
  74. malice) so it pays to take precautions.  Alethic recomends frequent
  75. saving of backup copies of phone directory and mail files (notice that these
  76. files are intimately related so that a saved PHONE without its corresponding
  77. OUTMAIL at least will cause trouble up to and including a system crash).  In
  78. particular, it would be sensible to make a backup copy of PHONE before
  79. running PMERGE.
  80.  
  81.             ERROR MESSAGES and EXIT CODES
  82.  
  83. The following are the error messages and exit codes produced by PMERGE when
  84. it encounters an error condition.  In quiet mode, no message is printed
  85. except for error 1.
  86.  
  87. EXIT CODE               MESSAGE                 ACTION
  88.  
  89.    1                    PMERGE found an option  Re-enter the command line with
  90.                         on the command line     typos corrected.  Consult the
  91.                         which it couldn't       list of options.
  92.                         interpret.  A summary
  93.                         of the allowable
  94.                         options is printed.
  95.  
  96.    2                    No phone number found.  Either re-enter the command
  97.                                                 line giving the -P option or
  98.                                                 set the environment variable
  99.                                                 PHONE to the user's number.
  100.  
  101.    3                    Bad phone format.       Re-enter the command line or
  102.                                                 re-set the environment
  103.                                                 variable making sure that the
  104.                                                 number has 10 digits (include
  105.                                                 area code) with no spaces or
  106.                                                 punctuation.
  107.  
  108.    4                    Error opening user's    Make certain that PMERGE is
  109.                         original phone          told the correct location of
  110.                         directory.              the original directory either
  111.                                                 by means of the -B option or
  112.                                                 the environment variable
  113.                                                 BACKMAIL.  If this information
  114.                                                 is not given PMERGE, will
  115.                                                 assume (perhaps wrongly) that
  116.                                                 the phone directory is in
  117.                                                 C:\BACKMAIL.
  118.  
  119.    5,6                  Error creating          During its operation PMERGE
  120.                         temporary files.        must create temporary files to
  121.                                                 hold information.  If the user
  122.                                                 is low on disk space this error
  123.                                                 might well result.  Clean up
  124.                                                 unnecessary files.
  125.  
  126.    7                    Error opening file      The 'foreign' phone directory
  127.                         of new phone numbers.   must be in the current
  128.                                                 subdirectory.
  129.  
  130.    8                    Error writing to        This error, like 5 and 6 is
  131.                         temporary files.        typically the result of not
  132.                                                 having enough disk space to
  133.                                                 run PMERGE.
  134.  
  135.   9                     Wrong version.          PMERGE has discovered that one
  136.                                                 or both of the phone
  137.                                                 directories that it has been
  138.                                                 asked to merge are in a format
  139.                                                 that it doesn't recognise.
  140.                                                 Make certain that both phone
  141.                                                 directories are in BackMail
  142.                                                 format and of a version which
  143.                                                 is no later than the version
  144.                                                 of PMERGE (printed when it
  145.                                                 starts).  If necessary obtain
  146.                                                 a later version of PMERGE.
  147.